Skip to content

[FC-0099] refactor: avoid duplicates when getting role scopes#137

Merged
mariajgrimaldi merged 3 commits intomainfrom
MJG/avoid-scope-dups
Nov 11, 2025
Merged

[FC-0099] refactor: avoid duplicates when getting role scopes#137
mariajgrimaldi merged 3 commits intomainfrom
MJG/avoid-scope-dups

Conversation

@mariajgrimaldi
Copy link
Copy Markdown
Member

@mariajgrimaldi mariajgrimaldi commented Nov 7, 2025

Description

This is a hot-fix cause I think this might be part of a bigger issue. This PR avoids duplicates when getting the scopes for a user role assignments. I hit some race condition and generated this which only affects this function, the rest API for role assignments / roles return the proper number of assignments though.

image

Could this be related to a stale read-before-write? I'll ask internally to review the sanbodx database in case we somehow have duplicates - there are no duplicates. This is even more puzzling, I'll be testing this and openedx/openedx-platform#37564 in case there is something missing.

Merge checklist:
Check off if complete or not applicable:

  • Version bumped
  • Changelog record added
  • Documentation updated (not only docstrings)
  • Fixup commits are squashed away
  • Unit tests added/updated
  • Manual testing instructions provided
  • Noted any: Concerns, dependencies, migration issues, deadlines, tickets

@openedx-webhooks
Copy link
Copy Markdown

Thanks for the pull request, @mariajgrimaldi!

This repository is currently maintained by @openedx/committers-openedx-authz.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Nov 7, 2025
@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Nov 7, 2025
Copy link
Copy Markdown
Contributor

@rodmgwgu rodmgwgu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks

Comment thread openedx_authz/api/data.py Outdated
# Subclasses like ContentLibraryData ('lib') represent concrete resource types with their own namespaces.
NAMESPACE: ClassVar[str] = "global"

def __eq__(self, other: "ScopeData") -> bool:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good, but I'm not sure why the codecov report indicates that this method is uncovered.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:o thanks for bringing this up! I'll look into it

Copy link
Copy Markdown
Member Author

@mariajgrimaldi mariajgrimaldi Nov 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So @define already creates the correct eq, and since this is the parent of ContentLibraryData it gets overridden. I dropped it since we don't need it in this case :)

@mariajgrimaldi mariajgrimaldi changed the title refactor: avoid duplicates when getting role scopes [FC-0099] refactor: avoid duplicates when getting role scopes Nov 11, 2025
@mariajgrimaldi mariajgrimaldi merged commit f33befd into main Nov 11, 2025
14 checks passed
@mariajgrimaldi mariajgrimaldi deleted the MJG/avoid-scope-dups branch November 11, 2025 10:10
@github-project-automation github-project-automation Bot moved this from Needs Triage to Done in Contributions Nov 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

5 participants